[Enhancement] Import by natural key fields by SchrodingersGat · Pull Request #11288 · inventree/InvenTree

SchrodingersGat · 2026-02-11T11:24:47Z

This PR allows for data importing by "natural key" fields on related models. Instead of forcing data import by primary key (pk) value only, other fields can be used for lookup.

Examples

Lookup 'Part' by IPN
Lookup 'SupplierPart' by SKU
Lookup 'SalesOrder' by reference

Related Issues

Closes BOM import: add field selection for item reference (ID/IPN/Name) #10268 (replaces)
Closes [FR] Add IPN as matching field for BoM import #9248
Closes [Importer] Natural Key Support #7574

TODO

Support wider range of models with natural keys
Updated playwright tests
Enhanced documentation around data import

- Allow specification of alternative lookup fields for data import

netlify · 2026-02-11T11:24:53Z

✅ Deploy Preview for inventree-web-pui-preview canceled.

Name	Link
🔨 Latest commit	`47c0295`
🔍 Latest deploy log	https://app.netlify.com/projects/inventree-web-pui-preview/deploys/6997cf1528e51b0008068758

Copilot

Pull request overview

This PR introduces natural key field support for data imports in InvenTree, allowing related models to be referenced by human-readable identifiers (like IPN, SKU, MPN) instead of requiring primary key values. This enhancement makes importing data from external sources more intuitive and reduces the need for manual ID lookups.

Changes:

Added lookup_related_field method to perform natural key lookups on related fields during import
Added get_related_model method to retrieve related model classes for field lookups
Defined IMPORT_ID_FIELDS on multiple models (Part, PartCategory, PartTestTemplate, Company, ManufacturerPart, SupplierPart, Order, Build) to specify which fields can be used for natural key lookups

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
src/backend/InvenTree/importer/models.py	Core implementation of natural key lookup functionality with `lookup_related_field` and `get_related_model` methods
src/backend/InvenTree/part/models.py	Added IMPORT_ID_FIELDS for Part, PartCategory, and PartTestTemplate models
src/backend/InvenTree/company/models.py	Added IMPORT_ID_FIELDS for Company, ManufacturerPart, and SupplierPart models
src/backend/InvenTree/order/models.py	Added IMPORT_ID_FIELDS to abstract Order model
src/backend/InvenTree/build/models.py	Added IMPORT_ID_FIELDS to Build model

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/backend/InvenTree/importer/models.py

src/backend/InvenTree/part/models.py

src/backend/InvenTree/importer/models.py

src/backend/InvenTree/part/models.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

codecov · 2026-02-11T12:24:17Z

Codecov Report

❌ Patch coverage is 34.84848% with 43 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.98%. Comparing base (1ac3f5e) to head (47c0295).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #11288      +/-   ##
==========================================
- Coverage   88.04%   87.98%   -0.07%     
==========================================
  Files        1292     1292              
  Lines       58655    58720      +65     
  Branches     1943     1943              
==========================================
+ Hits        51645    51667      +22     
- Misses       6526     6569      +43     
  Partials      484      484

Flag	Coverage Δ
backend	`89.18% <34.84%> (-0.08%)`	⬇️
migrations	`42.16% <27.27%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
Backend Apps	`91.70% <32.81%> (-0.11%)`	⬇️
Backend General	`93.37% <100.00%> (+<0.01%)`	⬆️
Frontend	`70.88% <ø> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…k-field

codspeed-hq · 2026-02-19T23:22:34Z

Merging this PR will degrade performance by 9.26%

⚠️

Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

❌ 1 regressed benchmark
✅ 43 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

	Mode	Benchmark	`BASE`	`HEAD`	Efficiency
❌	WallTime	`test_api_list_performance[/api/build/item/]`	298.1 ms	328.5 ms	-9.26%

_{Comparing SchrodingersGat:import-pk-field (47c0295) with master (1ac3f5e)}

SchrodingersGat added 4 commits February 11, 2026 11:12

Data import flexibility

e9d6c2a

- Allow specification of alternative lookup fields for data import

Observe field filters during data import

29e07c4

Add alternative import fields for Part models

d94ff35

More options for IMPORT_ID_FIELDS

a276187

SchrodingersGat added this to the 1.3.0 milestone Feb 11, 2026

SchrodingersGat added enhancement This is an suggested enhancement or new feature import / export Data importing, exporting and processing feature full-run Always do a full QC CI run labels Feb 11, 2026

SchrodingersGat mentioned this pull request Feb 11, 2026

BOM import: add field selection for item reference (ID/IPN/Name) #10268

Closed

SchrodingersGat requested review from Copilot and matmair February 11, 2026 11:42

Merge branch 'master' into import-pk-field

05e0f8a

Copilot started reviewing on behalf of SchrodingersGat February 11, 2026 11:43 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

Update src/backend/InvenTree/importer/models.py

a7a4020

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

SchrodingersGat added 11 commits February 13, 2026 08:31

Merge branch 'master' into import-pk-field

2b2cdf8

Bump CHANGELOG

bd5b2b3

Handle empty input values

e6090d5

Add IMPORT_ID_FIELDS for more models

d0c469f

PK field takes highest priority

4fa079d

Update import docs

9de8fe6

Tweak return type

3ef04dc

Merge branch 'master' into import-pk-field

0edf6ec

Merge branch 'master' into import-pk-field

a1ce10c

Merge commit 'a4a399022f5bb6c63b68416bfce8b1f4a63ba35e' into import-p…

ee9394c

…k-field

Merge commit 'dd423dccd6cd3447f8bae7ee55c1c58d8f2318a3' into import-p…

f62ffd1

…k-field

SchrodingersGat added 3 commits February 20, 2026 02:51

Handle multiple date formats

c0b7c55

Add playwright testing

2b6162b

Merge branch 'master' into import-pk-field

47c0295

SchrodingersGat merged commit 14d6d23 into inventree:master Feb 20, 2026
38 of 39 checks passed

SchrodingersGat deleted the import-pk-field branch February 20, 2026 04:30

matmair mentioned this pull request Mar 11, 2026

PO Line Item import does not properly lookup supplier part #11491

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Enhancement] Import by natural key fields#11288

[Enhancement] Import by natural key fields#11288
SchrodingersGat merged 20 commits intoinventree:masterfrom
SchrodingersGat:import-pk-field

SchrodingersGat commented Feb 11, 2026 •

edited

Loading

Uh oh!

netlify bot commented Feb 11, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 11, 2026 •

edited

Loading

Uh oh!

codspeed-hq bot commented Feb 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

SchrodingersGat commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related Issues

TODO

Uh oh!

netlify bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for inventree-web-pui-preview canceled.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will degrade performance by 9.26%

Performance Changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SchrodingersGat commented Feb 11, 2026 •

edited

Loading

netlify bot commented Feb 11, 2026 •

edited

Loading

codecov bot commented Feb 11, 2026 •

edited

Loading

codspeed-hq bot commented Feb 19, 2026 •

edited

Loading